Interface OSPFProcess

All Superinterfaces:
IPCObject, Process, RoutingProtocol
All Known Implementing Classes:
OSPFProcessImpl

public interface OSPFProcess extends RoutingProtocol
Information provided by the PKI file:

    \class OspfProcess
    
    \brief OspfProcess is the process that handles the individual OSPF process.
    
    \example network().getDevice("Router0").getProcess("OspfMainProcess").getOspfProcessAt(0)
    
Author:
Auto-generated
  • Method Details

    • getProcessId

      int getProcessId()
      Information provided by the PKI file:
      
          \brief Returns the OSPF process ID.
          
          \return int, the OSPF process ID.
          
              
      Returns:
      int Returns a int
    • getRouterId

      IPAddress getRouterId()
      Information provided by the PKI file:
      
          \brief Returns the router-ID for this OSPF process.
          
          \return ip, the router-ID for this OSPF process.
          
              
      Returns:
      IPAddress Returns a IPAddress
    • getAreaCount

      int getAreaCount()
      Information provided by the PKI file:
      
          \brief Returns the number of OSPF areas.
          
          \return int, the number of OSPF areas.
          
              
      Returns:
      int Returns a int
    • getAreaAt

      OSPFArea getAreaAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the OSPF area at the specified index.
          
          \param index, the index of the OSPF area of interest.
          
          \return OspfArea, the OspfArea object at the specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      OSPFArea Returns a OSPFArea
    • getArea

      OSPFArea getArea(IPAddress ipAddressArea)
      Information provided by the PKI file:
      
          \brief Returns the OSPF area with the specified ID in IP address format.
          
          \param ipAddressArea, the ID in IP address format of the OSPF area of interest.
          
          \return OspfArea, the OspfArea object with the specified IP address.
          
              
      Parameters:
      ipAddressArea - Takes in a parameter of ipAddressArea
      Returns:
      OSPFArea Returns a OSPFArea
    • removeArea

      void removeArea(IPAddress ipAddressArea)
      Information provided by the PKI file:
      
          \brief Removes the OSPF area with the specified ID in IP address format.
          
          \param ipAddressArea, the ID in IP address format of the OSPF area of interest.
          
              
      Parameters:
      ipAddressArea - Takes in a parameter of ipAddressArea
    • setAreaAuthentication

      boolean setAreaAuthentication(IPAddress ipAddressArea, OSPFAuthType type)
      Information provided by the PKI file:
      
          \Sets the authentication type for the OSPF area with the specified ID in IP address format.
          
          \param ipAddressArea, the ID in IP address format of the OSPF area of interest.
          \param type,        the authentication type.
          Authentication types:       eNoAuth = 0,
          eAuth = 1,
          eMD5Auth = 2
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      ipAddressArea - Takes in a parameter of ipAddressArea
      type - Takes in a parameter of type
      Returns:
      boolean Returns a boolean
    • getAreaAuthenticationCount

      int getAreaAuthenticationCount()
      Information provided by the PKI file:
      
          \brief Returns the number of authenticated areas.
          
          \return int, the number of authenticated areas.
          
              
      Returns:
      int Returns a int
    • getAreaAuthenticationAt

      Pair<IPAddress,Integer> getAreaAuthenticationAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the ID in IP address format and authentication type of the authenticated area at the specifed index.
          
          \param index, the index of the authenticated area of interest.
          
          \return pair<ip, int>, the ID in IP address format and authentication type of the authenticated area at the specifed index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      Pair<IPAddress, Integer> Returns a Pair<IPAddress, Integer>
    • getAreaAuthentication

      OSPFAuthType getAreaAuthentication(IPAddress ipAddressArea)
      Information provided by the PKI file:
      
          \brief Returns the authentication type of the area with the specified ID in IP address format.
          
          \param ipAddressArea, the ID in IP address format of the area of interest.
          
          \return OspfAuthType,       the authentication type.
          Authentication types:       eNoAuth = 0,
          eAuth = 1,
          eMD5Auth = 2
          
              
      Parameters:
      ipAddressArea - Takes in a parameter of ipAddressArea
      Returns:
      OSPFAuthType Returns a OSPFAuthType
    • setDefaultInfoOrig

      void setDefaultInfoOrig(OSPFDefaultInfoOrig type)
      Information provided by the PKI file:
      
          \brief Sets the default information originate setting.
          
          \param type,        the default information originate setting.
          Default information originate settings:     eNoDefaultInfoOrig = 0,
          eDefaultInfoOrig = 1,
          eDefaultInfoOrigAlways = 2
          
              
      Parameters:
      type - Takes in a parameter of type
    • getDefaultInfoOrig

      OSPFDefaultInfoOrig getDefaultInfoOrig()
      Information provided by the PKI file:
      
          \brief Returns the default information originate setting.
          
          \return OspfDefaultInfoOrig,        the default information originate setting.
          Default information originate settings:     eNoDefaultInfoOrig = 0,
          eDefaultInfoOrig = 1,
          eDefaultInfoOrigAlways = 2
          
              
      Returns:
      OSPFDefaultInfoOrig Returns a OSPFDefaultInfoOrig
    • setLogAdjacencyChanges

      void setLogAdjacencyChanges(OSPFLogChanges type)
      Information provided by the PKI file:
      
          \brief Sets the log adjacadeny changes setting.
          
          \param type,        the log adjacadeny changes setting.
          Log adjacadeny changes settings:    eNoLogChange = 0,
          eLogChange = 1,
          eLogChangeDetail = 2
          
              
      Parameters:
      type - Takes in a parameter of type
    • getLogAdjacencyChanges

      OSPFLogChanges getLogAdjacencyChanges()
      Information provided by the PKI file:
      
          \brief Returns the log adjacadeny changes setting.
          
          \return OspfLogChanges,     the log adjacadeny changes setting.
          Log adjacadeny changes settings:    eNoLogChange = 0,
          eLogChange = 1,
          eLogChangeDetail = 2
          
              
      Returns:
      OSPFLogChanges Returns a OSPFLogChanges
    • addConfiguredNetwork

      void addConfiguredNetwork(IPAddress ipAddressArea, IPAddress ipAddress, IPAddress mask)
      Information provided by the PKI file:
      
          \brief Enables OSPF routing in the specified OSPF area for the specified network.
          
          \param ipAddressArea, the ID in IP address format of the OSPF area.
          \param ipAddress, the network address.
          \param mask, the OSPF wild card bits.
          
              
      Parameters:
      ipAddressArea - Takes in a parameter of ipAddressArea
      ipAddress - Takes in a parameter of ipAddress
      mask - Takes in a parameter of mask
    • removeConfigureNetwork

      void removeConfigureNetwork(IPAddress ipAddressArea, IPAddress ipAddress, IPAddress mask)
      Information provided by the PKI file:
      
          \brief Disables OSPF routing in the specified OSPF area for the specified network.
          
          \param ipAddressArea, the ID in IP address format of the OSPF area.
          \param ipAddress, the network address.
          \param mask, the OSPF wild card bits.
          
              
      Parameters:
      ipAddressArea - Takes in a parameter of ipAddressArea
      ipAddress - Takes in a parameter of ipAddress
      mask - Takes in a parameter of mask
    • getConfNetworkCount

      int getConfNetworkCount()
      Information provided by the PKI file:
      
          \brief Returns the number of configured networks.
          
          \return int, the number of configured networks.
          
              
      Returns:
      int Returns a int
    • getConfNetworkAt

      OSPFAreaNetwork getConfNetworkAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the configured network at the specified index.
          
          \param index, the index of the network of interest.
          
          \return OspfAreaNetwork, the OspfAreaNetwork object.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      OSPFAreaNetwork Returns a OSPFAreaNetwork
    • getAreaId

      IPAddress getAreaId(IPAddress ipAddress, IPAddress mask)
      Information provided by the PKI file:
      
          \brief Returns the area ID in IP address format of the specified network.
          
          \param ipAddress, the network address.
          \param mask, the OSPF wild card bits.
          
          \return ip, the ID in IP address format of the specified network.
          
              
      Parameters:
      ipAddress - Takes in a parameter of ipAddress
      mask - Takes in a parameter of mask
      Returns:
      IPAddress Returns a IPAddress
    • setDefaultPassiveInt

      void setDefaultPassiveInt(boolean b)
      Information provided by the PKI file:
      
          \brief Enables or disables default passive interface.
          
          \param b, true to enable default passive interface, false to disable it.
          
              
      Parameters:
      b - Takes in a parameter of b
    • getDefaultPassiveInt

      boolean getDefaultPassiveInt()
      Information provided by the PKI file:
      
          \brief Returns true if default passive interface is enabled, otherwise false.
          
          \return bool, true if default passive interface is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • setPassiveInt

      void setPassiveInt(String portname, boolean bPassive)
      Information provided by the PKI file:
      
          \brief Enables or disables passive interface for the specified port.
          
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          \param bPassive, true to enable passive interface, false to disable it.
          
              
      Parameters:
      portname - Takes in a parameter of portname
      bPassive - Takes in a parameter of bPassive
    • generateOspfRoutes

      void generateOspfRoutes(IPAddress ipAddressAreaID)
      Information provided by the PKI file:
      
          \brief Generates the OSPF routes for the OSPF area with the specified ID in IP address format.
          
          \param ipAddressAreaID, the ID in IP address format of the OSPF area of interest.
          
              
      Parameters:
      ipAddressAreaID - Takes in a parameter of ipAddressAreaID